Package com.cisco.pt.ipc.sim.impl
Class ScriptModuleImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.CepInstanceImpl
com.cisco.pt.ipc.sim.impl.ScriptModuleImpl
- All Implemented Interfaces:
IPCObject,ScriptModule,CepInstance
Information provided by the PKI file:
\class CScriptModule
\brief CScriptModule access from itself.
\example ipcManager().thisInstance()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionScriptModuleImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptiongetInterface(String id) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getScriptCode(String id) Information provided by the PKI file:booleanhasInterface(String id) Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanshouldPromptExternalServerOperation(String protocol, int port) Information provided by the PKI file:booleanstop()Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.system.impl.CepInstanceImpl
addExclusivePublisher, clearExclusivePublishers, getCep, getCommandLineArg, getExclusivePublisherAt, getExclusivePublisherCount, getInstanceId, hasExclusivePublisher, removeExclusivePublisher, removeExclusivePublisherAtMethods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.system.CepInstance
addExclusivePublisher, clearExclusivePublishers, getCep, getCommandLineArg, getExclusivePublisherAt, getExclusivePublisherCount, getInstanceId, hasExclusivePublisher, removeExclusivePublisher, removeExclusivePublisherAtMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
ScriptModuleImpl
public ScriptModuleImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
stop
public boolean stop()Information provided by the PKI file:
\brief Stop Script Module \return bool, true if it has been stopped and false if otherwise- Specified by:
stopin interfaceScriptModule- Returns:
- boolean Returns a boolean
-
getScriptCode
Information provided by the PKI file:
\brief Get Script Code based on script id \param id, script id \return QString, Script code- Specified by:
getScriptCodein interfaceScriptModule- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
getScript
Information provided by the PKI file:
\brief Get Script Code based on script id and processes translations on the code, if exists. \param id, script id \return QString, processed Script code- Specified by:
getScriptin interfaceScriptModule- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
hasScript
Information provided by the PKI file:
\brief Check if the script exists using script id \param id, script id \return bool, true if it exists and false otherwise- Specified by:
hasScriptin interfaceScriptModule- Parameters:
id- Takes in a parameter of id- Returns:
- boolean Returns a boolean
-
getInterfaceCode
Information provided by the PKI file:
\brief Get Interface Code based on Interface id.. \param id, Interface id \return QString, Interface code- Specified by:
getInterfaceCodein interfaceScriptModule- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
getInterface
Information provided by the PKI file:
\brief Get Interface Code based on Interface id and processes translations on the code, if exists. \param id, Interface id \return QString, processed Interface code- Specified by:
getInterfacein interfaceScriptModule- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
hasInterface
Information provided by the PKI file:
\brief Check if the Interface exists using Interface id \param id, Interface id \return bool, true if it exists and false otherwise- Specified by:
hasInterfacein interfaceScriptModule- Parameters:
id- Takes in a parameter of id- Returns:
- boolean Returns a boolean
-
getScriptDataStore
- Specified by:
getScriptDataStorein interfaceScriptModule- Parameters:
id- Takes in a parameter of id- Returns:
- String Returns a String
-
shouldPromptExternalNetworkAccess
public boolean shouldPromptExternalNetworkAccess()Information provided by the PKI file:
\brief This delegate determines if script module should prompt for external network access. \return bool, true if script module should prompt, otherwise false.- Specified by:
shouldPromptExternalNetworkAccessin interfaceScriptModule- Returns:
- boolean Returns a boolean
-
shouldPromptExternalServerOperation
Information provided by the PKI file:
\brief This delegate determines if script module should prompt for external server operation. \param protocol, HTTP or TCP \param port, the port to listen on \return bool, true if script module should prompt, otherwise false.- Specified by:
shouldPromptExternalServerOperationin interfaceScriptModule- Parameters:
protocol- Takes in a parameter of protocolport- Takes in a parameter of port- Returns:
- boolean Returns a boolean
-